<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>BatchMMJ2</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="BatchMMJ2";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../mmj/util/BatchFramework.html" title="class in mmj.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mmj/util/Boss.html" title="class in mmj.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mmj/util/BatchMMJ2.html" target="_top">Frames</a></li>
<li><a href="BatchMMJ2.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_mmj.util.BatchFramework">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">mmj.util</div>
<h2 title="Class BatchMMJ2" class="title">Class BatchMMJ2</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../mmj/util/BatchFramework.html" title="class in mmj.util">mmj.util.BatchFramework</a></li>
<li>
<ul class="inheritance">
<li>mmj.util.BatchMMJ2</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">BatchMMJ2</span>
extends <a href="../../mmj/util/BatchFramework.html" title="class in mmj.util">BatchFramework</a></pre>
<div class="block">BatchMMJ2 is the main batch mmj2 program to process a Metamath (.mm) file.
 <p>
 Please refer to <code>mmj.util.CommandLineArguments.java</code> for details about
 the command line arguments used. </ol></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_mmj.util.BatchFramework">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;mmj.util.<a href="../../mmj/util/BatchFramework.html" title="class in mmj.util">BatchFramework</a></h3>
<code><a href="../../mmj/util/BatchFramework.html#batchFrameworkInitialized">batchFrameworkInitialized</a>, <a href="../../mmj/util/BatchFramework.html#commandLineArguments">commandLineArguments</a>, <a href="../../mmj/util/BatchFramework.html#runParmFile">runParmFile</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../mmj/util/BatchMMJ2.html#BatchMMJ2()">BatchMMJ2</a></strong>()</code>
<div class="block">Default Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../mmj/util/BatchMMJ2.html#checkVersion()">checkVersion</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../mmj/util/BatchMMJ2.html#generateSvcCallback(java.lang.String[], mmj.svc.SvcCallback)">generateSvcCallback</a></strong>(java.lang.String[]&nbsp;args,
                   <a href="../../mmj/svc/SvcCallback.html" title="interface in mmj.svc">SvcCallback</a>&nbsp;svcCallback)</code>
<div class="block">Secondary entry point for BatchMMJ2 to trigger a callback to the
 designated object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../mmj/util/BatchMMJ2.html#main(java.lang.String[])">main</a></strong>(java.lang.String[]&nbsp;args)</code>
<div class="block">Main function interfacing to Java environment, running the BatchMMJ2
 functions.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_mmj.util.BatchFramework">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;mmj.util.<a href="../../mmj/util/BatchFramework.html" title="class in mmj.util">BatchFramework</a></h3>
<code><a href="../../mmj/util/BatchFramework.html#addAnyExtraBossesToBossList()">addAnyExtraBossesToBossList</a>, <a href="../../mmj/util/BatchFramework.html#addBossToBossList(mmj.util.Boss)">addBossToBossList</a>, <a href="../../mmj/util/BatchFramework.html#executeRunParmCommand(mmj.util.RunParmArrayEntry)">executeRunParmCommand</a>, <a href="../../mmj/util/BatchFramework.html#getRunParmFileAbsolutePath()">getRunParmFileAbsolutePath</a>, <a href="../../mmj/util/BatchFramework.html#initializeBatchFramework()">initializeBatchFramework</a>, <a href="../../mmj/util/BatchFramework.html#isCurrentRunParmCommand(java.lang.String)">isCurrentRunParmCommand</a>, <a href="../../mmj/util/BatchFramework.html#printCommentRunParmLine(java.lang.String, int, mmj.util.RunParmArrayEntry)">printCommentRunParmLine</a>, <a href="../../mmj/util/BatchFramework.html#printExecutableRunParmLine(java.lang.String, int, mmj.util.RunParmArrayEntry)">printExecutableRunParmLine</a>, <a href="../../mmj/util/BatchFramework.html#runIt(java.lang.String[])">runIt</a>, <a href="../../mmj/util/BatchFramework.html#setRunParmCommentCaption()">setRunParmCommentCaption</a>, <a href="../../mmj/util/BatchFramework.html#setRunParmExecutableCaption()">setRunParmExecutableCaption</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="BatchMMJ2()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BatchMMJ2</h4>
<pre>public&nbsp;BatchMMJ2()</pre>
<div class="block">Default Constructor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="main(java.lang.String[])">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)</pre>
<div class="block">Main function interfacing to Java environment, running the BatchMMJ2
 functions.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - see class description.</dd></dl>
</li>
</ul>
<a name="generateSvcCallback(java.lang.String[], mmj.svc.SvcCallback)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateSvcCallback</h4>
<pre>public&nbsp;int&nbsp;generateSvcCallback(java.lang.String[]&nbsp;args,
                      <a href="../../mmj/svc/SvcCallback.html" title="interface in mmj.svc">SvcCallback</a>&nbsp;svcCallback)</pre>
<div class="block">Secondary entry point for BatchMMJ2 to trigger a callback to the
 designated object.
 <p>
 To use this entry point insert the following code, or something like it,
 in your program:
 </p>
 
 <pre>
 BatchMMJ2 batchMMJ2 = new BatchMMJ2();
 String[] myArgs = {&quot;RunParms.txt&quot;};
 MyMMJSvcCallback mySvcCallback = new MyMMJSvcCallback();
 batchMMJ2.generateSvcCallback(myArgs, mySvcCallback);
 </pre>
 
 See mmj2 for info about the content of the RunParms file, as well as the
 description for this class for information about other args.
 <p>
 The call to generateSvcCallback will run the BatchMMJ2 process in the
 normal way, and if there are no errors and a RunParm is encountered
 specifying execution of a SvcCallback, your SvcCallback's "go" method
 will be invoked.
 <p>
 From that point on your SvcCallback can utilize mmj2 objects as a
 "service" -- for example, you can unload the Metamath objects to
 s-expressions. Simply return from your SvcCallback.go() method to
 terminate.
 <p>
 NOTE: It is not necessary to use this entry point. A SvcCallback class
 can be specified via mmj2 RunParm. If that is done then a "callback" can
 be generated via RunParm command, which, in effect, would make your
 callback a subroutine of BatchMMJ2. You would just need to ensure that
 your class is in the Java Classpath in use when BatchMMJ2 is run.
 <p>
 NOTE: The SvcCallback parameter passed in here will be overridden by a
 RunParm SvcCallback -- but the "Clear" RunParm does not erase a
 SvcCallback parameter passed via setSvcCallback (contrary to the behavior
 of "Clear" elsewhere.)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - see class description.</dd><dd><code>svcCallback</code> - your concrete instantiation of the mmj SvcCallback
            interface.</dd>
<dt><span class="strong">Returns:</span></dt><dd>zero if no errors, otherwise severe error is signified and
         processing should terminate!</dd></dl>
</li>
</ul>
<a name="checkVersion()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>checkVersion</h4>
<pre>public static&nbsp;void&nbsp;checkVersion()
                         throws java.lang.IllegalArgumentException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../mmj/util/BatchFramework.html" title="class in mmj.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mmj/util/Boss.html" title="class in mmj.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mmj/util/BatchMMJ2.html" target="_top">Frames</a></li>
<li><a href="BatchMMJ2.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_mmj.util.BatchFramework">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
